home *** CD-ROM | disk | FTP | other *** search
/ MacFormat 1996 November / macformat-043.iso / mac / Shareware Plus / Developers / OpenStack Rinaldi Collection / openstack-rinaldi-lib / CreateMenuHelp 1.0 (US) / CreateMenuHelp 1.0 (US).rsrc / HELP_5635 next >
Encoding:
Text File  |  1996-01-09  |  2.7 KB  |  57 lines
  1.  
  2.  
  3.                                        CreateMenuHelp 1.0
  4.  
  5.                                          by Frédéric RINALDI
  6.  
  7. DESCRIPTION
  8.   CreateMenuHelp creates "hmnu" resource to be used by the Help Mgr in order to provide menus help balloons. It requires System 7.0.
  9.  
  10. SYNTAX
  11.          CreateMenuHelp <menu name>,<help string>[,<item separator>]
  12.  
  13. PARAMETERS
  14.    <menu name> is a string giving the name of the menu for which help has to be added.
  15.  
  16.    <help string> is a complex string giving the help text for each item :
  17.        line 1 : help text for undocumented items
  18.        line 2 : help text for the  menu iself
  19.        line 3 : help text for item 1
  20.        ...
  21.        line N : help text for item N-2
  22.    Each line is made of four entries (default separator is comma), being respectively : 
  23.  <enabled help>,<disabled help>,<checked help>,<non-standard check help>
  24.    Line 2 of the container giving help for the menu itself has a slightly different meaning :
  25.  <enabled help>,<disabled help>,<menu modal-dimmed help>,<items modal-dimmed help>
  26.    If returns are needed in any help string, just put a "¶" char which will be replaced by the XCMD in the created resource.
  27.  
  28.    <item separator> is a single char allowing to define any non-standard entry separator, which is useful when there are commas in the help text.
  29.  
  30.    Using "!", "?" and "=" as first parameter will return an online help (resp. copyright,  syntax and output).
  31.  
  32. USING
  33.    The XCMD creates a "hmnu" resource in the current stack, having the ID and name of the corresponding menu.
  34.    Any duplicate "hmnu" resource is simply replaced by the new one without warning.
  35.  
  36.    If you want to be able to add menu help to any stack, simply click on the button Start using this stack, then you will just need to type "CMH" from any stack to add help resources to it.
  37.  
  38. ERRORS
  39.    If an error occurs, CreateMenuHelp can return :
  40.      "Error : Adding resource failed"
  41.      "Error : Menu not found"
  42.      "Error : Out of memory"
  43.      "Error : Help Mgr not found"
  44.      "Error : Missing or empty parameter"
  45.      "Error : Out of memory"
  46.  
  47.    This stack also uses MenuItemsList XFCN, © F. Rinaldi 1991.
  48. --------------------------------------------------------------------
  49.    All externals included in this stack are FreeWare and may be used in non-commercial software provided the following notice is visibly present :
  50.  
  51.                    CreateMenuHelp XCMD & MenuItemsList XFCN,
  52.                           © Frederic Rinaldi, 1989…1993.
  53.  
  54.    Free for non-commercial use. Use in commercial software subjected to prior acknowledgement and licensing from the author, reachable at the following network addresses:
  55.  
  56. AppleLink: RINALDI1   CalvaCom : FR10    Compuserve : 71170,2111
  57.                Internet : RINALDI1@APPLELINK@APPLE.COM